Nacos 服务配置中心

基础配置

首先引入 Spring Cloud Alibaba 的大礼包

<!--spring cloud 阿里巴巴-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>${spring-cloud-alibaba.version}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

在子模块中引入服务发现的包和配置中心包

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

<!-- 主要配置依赖 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

编写配置文件，注意这里得使用两个配置文件 application.yml 和 bootstrap.yml

之所以需要两个是因为：Nacos 同 SpringCloud Config 一样，在项目初始化时，要保证先从配置中心进行配置拉取，拉取配置之后才能保证项目的正常启动。（Spring Boot 中配置文件加载是存在优先级顺序的，bootstrap 优先级高于 application）

bootstrap.yml 的配置如下：

server:
  port: 3377

spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.211.138:8848 # Nacos 服务注册中心地址（把自己注册进 Nacos 里面）
      config:
        server-addr: 192.168.211.138:8848 # Nacos 作为配置中心地址
        file-extension: yaml              # 指定 yaml 格式的配置
        group: DEFAULT_GROUP              # 设置分组    
        #group: DEV_GROUP
        # namespace: e69dbe0a-233d-4b73-a173-89e9e8a1d041

# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file.extension}
# nacos-config-client-dev.yml

application.yml 的配置如下：

spring:
  profiles:
    active: dev   # 开发环境
    #active: test # 测试环境
    #active: info

编写 Controller

注意这个 @RefreshScope 注解，这个注解的作用是让 Bean 可以在运行时刷新，并且使用它们的任何组件都将在下一个方法调用上获得一个新实例，该实例将完全初始化并注入所有依赖项。（就是支持动态刷新当前 Bean）

@RestController
@RefreshScope   //SpringCloud原生注解 支持Nacos的动态刷新功能
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/config/info")
    public String getConfigInfo() {
        return configInfo;
    }
}

配置文件的匹配规则

具体参考官方文档

Nacos 中的 dataId 的组成格式及与 SpringBoot 配置文件中的匹配规则，在 Nacos Spring Cloud 中，dataId 的完整格式如下：

${prefix}-${spring.profiles.active}.${file-extension}

1、prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。

2、spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot 文档。

注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}

3、file-extension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新：

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${useLocalCache:false}")
    private boolean useLocalCache;

    @RequestMapping("/get")
    public boolean get() {
        return useLocalCache;
    }
}

最后完整的公式为：

${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file.extension}

所以上面的那个 yml 对应的配置文件

nacos-config-client-dev.yml

然后再在 Nacos 配置中心中添加新的配置

遇到的坑

配置好上面那个之后，启动后发现还是报错了

其实这是 Nacos 的一个坑，上面那个的 DataId 使用的是 yml，但是配置格式使用的确是 YAML，所以得把 DataId 改成 yaml

nacos-config-client-dev.yaml

注意：如果还是报错，检查 file-extension 和 group 是否写对

命名空间和 DataId

命名空间 和 DataId 主要用来解决如下两个问题

问题1：实际开发中，通常一个系统会准备

1. dev 开发环境
2. test 测试环境
3. prod 生产环境

如何保证指定环境启动时服务能正确读取到 Nacos 上相应环境的配置文件呢？

问题2：一个大型分布式微服务系统会有很多微服务子项目，每个微服务项目又都会有相应的开发环境、测试环境、预发环境、正式环境…那怎么对这些微服务配置进行管理呢？

Nacos 的图形化管理界面

Namespace + Group + DataId 三者关系？为什么这么设计？

它们的关系类似 Java 里面的 package 名和类名最外层的 namespace 是可以用于区分部署环境的，Group 和 DataId 逻辑上区分两个目标对象。

默认情况：Namespace=public，Group=DEFAULT_GROUP，默认 Cluster 是 DEFAULT

1、Nacos 默认的 Namespace 是 public，Namespace 主要用来实现隔离：比方说我们现在有三个环境：开发、测试、生产环境，我们就可以创建三个 Namespace，不同的 Namespace 之间是隔离的。

2、Group 默认是 DEFAULT_GROUP，Group 可以把不同的微服务划分到同一个分组里面去

3、Service 就是微服务：一个 Service 可以包含多个 Cluster（集群），Nacos 默认 Cluster 是 DEFAULT，Cluster 是对指定微服务的一个虚拟划分。比方说为了容灾，将 Service 微服务分别部署在了杭州机房和广州机房，这时就可以给杭州机房的 Service 微服务起一个集群名称(HZ) ，给广州机房的 Service 微服务起一个集群名称(GZ)，还可以尽量让同一个机房的微服务互相调用，以提升性能。

4、最后是 Instance，就是微服务的实例。

DataID 配置

再配置一个 DataId

通过 spring.profile.active 属性就能进行多环境下配置文件的读取

Group 分组方案

bootstrap + application

在 config 下增加一条 group 的配置即可。可配置为 DEV_GROUP 或 TEST_GROUP

Namespace 空间方案

新建 dev/test 的 Namespace

回到服务管理-服务列表查看

按照域名配置填写

YML

# nacos配置
server:
  port: 3377

spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 # Nacos作为配置中心地址
        file-extension: yaml        # 指定yaml格式的配置
        group: DEV_GROUP
        namespace: 7d8f0f5a-6a53-4785-9686-dd460158e5d4 #<------------指定namespace


# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# nacos-config-client-dev.yaml

# nacos-config-client-test.yaml   ----> config.info